home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_xemacs.idb / usr / freeware / lib / xemacs-20.4 / lisp / utils / derived.el.z / derived.el
Encoding:
Text File  |  1998-05-21  |  13.6 KB  |  362 lines
  1. ;;; derived.el --- allow inheritance of major modes.
  2. ;;; (formerly mode-clone.el)
  3.  
  4. ;; Copyright (C) 1993, 1994 Free Software Foundation, Inc.
  5.  
  6. ;; Author: David Megginson (dmeggins@aix1.uottawa.ca)
  7. ;; Maintainer: FSF
  8.  
  9. ;; This file is part of XEmacs.
  10.  
  11. ;; XEmacs is free software; you can redistribute it and/or modify it
  12. ;; under the terms of the GNU General Public License as published by
  13. ;; the Free Software Foundation; either version 2, or (at your option)
  14. ;; any later version.
  15.  
  16. ;; XEmacs is distributed in the hope that it will be useful, but
  17. ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  18. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19. ;; General Public License for more details.
  20.  
  21. ;; You should have received a copy of the GNU General Public License
  22. ;; along with XEmacs; see the file COPYING.  If not, write to the Free
  23. ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  24. ;; 02111-1307, USA.
  25.  
  26. ;;; Synched up with: FSF 19.34.
  27.  
  28. ;;; Commentary:
  29.  
  30. ;; GNU Emacs is already, in a sense, object oriented -- each object
  31. ;; (buffer) belongs to a class (major mode), and that class defines
  32. ;; the relationship between messages (input events) and methods
  33. ;; (commands) by means of a keymap.
  34. ;;
  35. ;; The only thing missing is a good scheme of inheritance.  It is
  36. ;; possible to simulate a single level of inheritance with generous
  37. ;; use of hooks and a bit of work -- sgml-mode, for example, also runs
  38. ;; the hooks for text-mode, and keymaps can inherit from other keymaps
  39. ;; -- but generally, each major mode ends up reinventing the wheel.
  40. ;; Ideally, someone should redesign all of Emacs's major modes to
  41. ;; follow a more conventional object-oriented system: when defining a
  42. ;; new major mode, the user should need only to name the existing mode
  43. ;; it is most similar to, then list the (few) differences.
  44. ;;
  45. ;; In the mean time, this package offers most of the advantages of
  46. ;; full inheritance with the existing major modes.  The macro
  47. ;; `define-derived-mode' allows the user to make a variant of an existing
  48. ;; major mode, with its own keymap.  The new mode will inherit the key
  49. ;; bindings of its parent, and will, in fact, run its parent first
  50. ;; every time it is called.  For example, the commands
  51. ;;
  52. ;;  (define-derived-mode hypertext-mode text-mode "Hypertext"
  53. ;;    "Major mode for hypertext.\n\n\\{hypertext-mode-map}"
  54. ;;    (setq case-fold-search nil))
  55. ;;
  56. ;;  (define-key hypertext-mode-map [down-mouse-3] 'do-hyper-link)
  57. ;;
  58. ;; will create a function `hypertext-mode' with its own (sparse)
  59. ;; keymap `hypertext-mode-map.'  The command M-x hypertext-mode will
  60. ;; perform the following actions:
  61. ;;
  62. ;; - run the command (text-mode) to get its default setup
  63. ;; - replace the current keymap with 'hypertext-mode-map,' which will
  64. ;;   inherit from 'text-mode-map'.
  65. ;; - replace the current syntax table with
  66. ;;   'hypertext-mode-syntax-table', which will borrow its defaults
  67. ;;   from the current text-mode-syntax-table.
  68. ;; - replace the current abbrev table with
  69. ;;   'hypertext-mode-abbrev-table', which will borrow its defaults
  70. ;;   from the current text-mode-abbrev table
  71. ;; - change the mode line to read "Hypertext"
  72. ;; - assign the value 'hypertext-mode' to the 'major-mode' variable
  73. ;; - run the body of commands provided in the macro -- in this case,
  74. ;;   set the local variable `case-fold-search' to nil.
  75. ;; - **run the command (hypertext-mode-setup), which is empty by
  76. ;;   default, but may be redefined by the user to contain special
  77. ;;   commands (ie. setting local variables like 'outline-regexp')
  78. ;;   **NOTE: do not use this option -- it will soon be obsolete.
  79. ;; - run anything assigned to 'hypertext-mode-hooks' (obsolete, but
  80. ;;   supported for the sake of compatibility).
  81. ;;
  82. ;; The advantages of this system are threefold.  First, text mode is
  83. ;; untouched -- if you had added the new keystroke to `text-mode-map,'
  84. ;; possibly using hooks, you would have added it to all text buffers
  85. ;; -- here, it appears only in hypertext buffers, where it makes
  86. ;; sense.  Second, it is possible to build even further, and make
  87. ;; a derived mode from a derived mode.  The commands
  88. ;;
  89. ;;   (define-derived-mode html-mode hypertext-mode "HTML")
  90. ;;   [various key definitions]
  91. ;; 
  92. ;; will add a new major mode for HTML with very little fuss.
  93. ;;
  94. ;; Note also the function `derived-mode-class,' which returns the non-derived
  95. ;; major mode which a derived mode is based on (ie. NOT necessarily the
  96. ;; immediate parent).
  97. ;;
  98. ;; (derived-mode-class 'text-mode) ==> text-mode
  99. ;; (derived-mode-class 'hypertext-mode) ==> text-mode
  100. ;; (derived-mode-class 'html-mode) ==> text-mode
  101.  
  102. ;;; Code:
  103.  
  104. ;; PUBLIC: define a new major mode which inherits from an existing one.
  105.  
  106. ;; XEmacs -- no autoload
  107. (defmacro define-derived-mode (child parent name &optional docstring &rest body)
  108.   "Create a new mode as a variant of an existing mode.
  109.  
  110. The arguments to this command are as follow:
  111.  
  112. CHILD:     the name of the command for the derived mode.
  113. PARENT:    the name of the command for the parent mode (ie. text-mode).
  114. NAME:      a string which will appear in the status line (ie. \"Hypertext\")
  115. DOCSTRING: an optional documentation string--if you do not supply one,
  116.            the function will attempt to invent something useful.
  117. BODY:      forms to execute just before running the
  118.            hooks for the new mode.
  119.  
  120. Here is how you could define LaTeX-Thesis mode as a variant of LaTeX mode:
  121.  
  122.   (define-derived-mode LaTeX-thesis-mode LaTeX-mode \"LaTeX-Thesis\")
  123.  
  124. You could then make new key bindings for `LaTeX-thesis-mode-map'
  125. without changing regular LaTeX mode.  In this example, BODY is empty,
  126. and DOCSTRING is generated by default.
  127.  
  128. On a more complicated level, the following command uses sgml-mode as
  129. the parent, and then sets the variable `case-fold-search' to nil:
  130.  
  131.   (define-derived-mode article-mode sgml-mode \"Article\"
  132.     \"Major mode for editing technical articles.\"
  133.     (setq case-fold-search nil))
  134.  
  135. Note that if the documentation string had been left out, it would have
  136. been generated automatically, with a reference to the keymap."
  137.  
  138.                     ; Some trickiness, since what
  139.                     ; appears to be the docstring
  140.                     ; may really be the first
  141.                     ; element of the body.
  142.   (if (and docstring (not (stringp docstring)))
  143.       (progn (setq body (cons docstring body))
  144.          (setq docstring nil)))
  145.   (setq docstring (or docstring (derived-mode-make-docstring parent child)))
  146.  
  147.   (` (progn 
  148.        (derived-mode-init-mode-variables (quote (, child)))
  149.        (defun (, child) ()
  150.      (, docstring)
  151.      (interactive)
  152.                     ; Run the parent.
  153.      ((, parent))
  154.                     ; Identify special modes.
  155.      (if (get (quote (, parent)) 'special)
  156.          (put (quote (, child)) 'special t))
  157.      ;; XEmacs addition
  158.      (let ((mode-class (get (quote (, parent)) 'mode-class)))
  159.        (if mode-class
  160.            (put (quote (, child)) 'mode-class mode-class)))
  161.                     ; Identify the child mode.
  162.      (setq major-mode (quote (, child)))
  163.      (setq mode-name (, name))
  164.                     ; Set up maps and tables.
  165.      (derived-mode-set-keymap (quote (, child)))
  166.      (derived-mode-set-syntax-table (quote (, child)))
  167.      (derived-mode-set-abbrev-table (quote (, child)))
  168.                     ; Splice in the body (if any).
  169.      (,@ body)
  170. ;;;                    ; Run the setup function, if
  171. ;;;                    ; any -- this will soon be
  172. ;;;                    ; obsolete.
  173. ;;;     (derived-mode-run-setup-function (quote (, child)))
  174.                     ; Run the hooks, if any.
  175.      (derived-mode-run-hooks (quote (, child)))))))
  176.  
  177.  
  178. ;; PUBLIC: find the ultimate class of a derived mode.
  179.  
  180. (defun derived-mode-class (mode)
  181.   "Find the class of a major mode.
  182. A mode's class is the first ancestor which is NOT a derived mode.
  183. Use the `derived-mode-parent' property of the symbol to trace backwards."
  184.   (while (get mode 'derived-mode-parent)
  185.     (setq mode (get mode 'derived-mode-parent)))
  186.   mode)
  187.  
  188.  
  189. ;; Inline functions to construct various names from a mode name.
  190.  
  191. (defsubst derived-mode-setup-function-name (mode)
  192.   "Construct a setup-function name based on a mode name."
  193.   (intern (concat (symbol-name mode) "-setup")))
  194.  
  195. (defsubst derived-mode-hooks-name (mode)
  196.   "Construct a hooks name based on a mode name."
  197.   ;; XEmacs change from -hooks
  198.   (intern (concat (symbol-name mode) "-hook")))
  199.  
  200. (defsubst derived-mode-map-name (mode)
  201.   "Construct a map name based on a mode name."
  202.   (intern (concat (symbol-name mode) "-map")))
  203.  
  204. (defsubst derived-mode-syntax-table-name (mode)
  205.   "Construct a syntax-table name based on a mode name."
  206.   (intern (concat (symbol-name mode) "-syntax-table")))
  207.  
  208. (defsubst derived-mode-abbrev-table-name (mode)
  209.   "Construct an abbrev-table name based on a mode name."
  210.   (intern (concat (symbol-name mode) "-abbrev-table")))
  211.  
  212.  
  213. ;; Utility functions for defining a derived mode.
  214.  
  215. ;; XEmacs -- don't autoload
  216. (defun derived-mode-init-mode-variables (mode)
  217.   "Initialise variables for a new mode. 
  218. Right now, if they don't already exist, set up a blank keymap, an
  219. empty syntax table, and an empty abbrev table -- these will be merged
  220. the first time the mode is used."
  221.  
  222.   (if (boundp (derived-mode-map-name mode))
  223.       t
  224.     (eval (` (defvar (, (derived-mode-map-name mode))
  225.            ;; XEmacs change
  226.            (make-sparse-keymap (derived-mode-map-name mode))
  227.            (, (format "Keymap for %s." mode)))))
  228.     (put (derived-mode-map-name mode) 'derived-mode-unmerged t))
  229.  
  230.   (if (boundp (derived-mode-syntax-table-name mode))
  231.       t
  232.     (eval (` (defvar (, (derived-mode-syntax-table-name mode))
  233.            ;; XEmacs change
  234.            ;; Make a syntax table which doesn't specify anything
  235.            ;; for any char.  Valid data will be merged in by
  236.            ;; derived-mode-merge-syntax-tables.
  237.            ;; (make-char-table 'syntax-table nil)
  238.            (make-syntax-table)
  239.            (, (format "Syntax table for %s." mode)))))
  240.     (put (derived-mode-syntax-table-name mode) 'derived-mode-unmerged t))
  241.  
  242.   (if (boundp (derived-mode-abbrev-table-name mode))
  243.       t
  244.     (eval (` (defvar (, (derived-mode-abbrev-table-name mode))
  245.            (progn (define-abbrev-table (derived-mode-abbrev-table-name mode) nil)
  246.               (make-abbrev-table))
  247.            (, (format "Abbrev table for %s." mode)))))))
  248.  
  249. (defun derived-mode-make-docstring (parent child)
  250.   "Construct a docstring for a new mode if none is provided."
  251.  
  252.   (format "This major mode is a variant of `%s', created by `define-derived-mode'.
  253. It inherits all of the parent's attributes, but has its own keymap,
  254. abbrev table and syntax table:
  255.  
  256.   `%s-map' and `%s-syntax-table'
  257.  
  258. which more-or-less shadow
  259.  
  260.   `%s-map' and `%s-syntax-table'
  261.  
  262. \\{%s-map}" parent child child parent parent child))
  263.  
  264.  
  265. ;; Utility functions for running a derived mode.
  266.  
  267. (defun derived-mode-set-keymap (mode)
  268.   "Set the keymap of the new mode, maybe merging with the parent."
  269.   (let* ((map-name (derived-mode-map-name mode))
  270.      (new-map (eval map-name))
  271.      (old-map (current-local-map)))
  272.     (and old-map
  273.      (get map-name 'derived-mode-unmerged)
  274.      (derived-mode-merge-keymaps old-map new-map))
  275.     (put map-name 'derived-mode-unmerged nil)
  276.     (use-local-map new-map)))
  277.  
  278. (defun derived-mode-set-syntax-table (mode) 
  279.   "Set the syntax table of the new mode, maybe merging with the parent."
  280.   (let* ((table-name (derived-mode-syntax-table-name mode))
  281.      (old-table (syntax-table))
  282.      (new-table (eval table-name)))
  283.     (if (get table-name 'derived-mode-unmerged)
  284.     (derived-mode-merge-syntax-tables old-table new-table))
  285.     (put table-name 'derived-mode-unmerged nil)
  286.     (set-syntax-table new-table)))
  287.  
  288. (defun derived-mode-set-abbrev-table (mode)
  289.   "Set the abbrev table if it exists.  
  290. Always merge its parent into it, since the merge is non-destructive."
  291.   (let* ((table-name (derived-mode-abbrev-table-name mode))
  292.      (old-table local-abbrev-table)
  293.      (new-table (eval table-name)))
  294.     (derived-mode-merge-abbrev-tables old-table new-table)
  295.     (setq local-abbrev-table new-table)))
  296.  
  297. ;;;(defun derived-mode-run-setup-function (mode)
  298. ;;;  "Run the setup function if it exists."
  299.  
  300. ;;;  (let ((fname (derived-mode-setup-function-name mode)))
  301. ;;;    (if (fboundp fname)
  302. ;;;    (funcall fname))))
  303.  
  304. (defun derived-mode-run-hooks (mode)
  305.   "Run the hooks if they exist."
  306.  
  307.   (let ((hooks-name (derived-mode-hooks-name mode)))
  308.     (if (boundp hooks-name)
  309.     (run-hooks hooks-name))))
  310.  
  311. ;; Functions to merge maps and tables.
  312.  
  313. (defun derived-mode-merge-keymaps (old new)
  314.   "Merge an old keymap into a new one.
  315. The old keymap is set to be the parent of the new one, so that there will
  316. be automatic inheritance."
  317.   ;; XEmacs change.  FSF 19.30 & 19.34 has a whole bunch of weird crap here
  318.   ;; for merging prefix keys and such.  Hopefully none of this is
  319.   ;; necessary in XEmacs.
  320.   (set-keymap-parents new (list old)))
  321.  
  322. (defun derived-mode-merge-syntax-tables (old new)
  323.   "Merge an old syntax table into a new one.
  324. Where the new table already has an entry, nothing is copied from the old one."
  325.   ;; 20.x
  326.   (if (fboundp 'map-char-table)
  327.       ;; we use map-char-table not map-syntax-table so we can explicitly
  328.       ;; check for inheritance.
  329.       (map-char-table
  330.        #'(lambda (key value)
  331.        (if (eq ?@ (char-syntax-from-code value))
  332.            (map-char-table #'(lambda (key1 value1)
  333.                    (put-char-table key1 value1 new))
  334.                    old
  335.                    key)))
  336.        new)
  337.     ;; pre-20.0
  338.     (let ((idx 0)
  339.       (end (min (length new) (length old))))
  340.       (while (< idx end)
  341.     (if (not (aref new idx))
  342.         (aset new idx (aref old idx)))
  343.     (setq idx (1+ idx))))))
  344.  
  345. ;; Merge an old abbrev table into a new one.
  346. ;; This function requires internal knowledge of how abbrev tables work,
  347. ;; presuming that they are obarrays with the abbrev as the symbol, the expansion
  348. ;; as the value of the symbol, and the hook as the function definition.
  349. (defun derived-mode-merge-abbrev-tables (old new)
  350.   (if old
  351.       (mapatoms 
  352.        (function 
  353.     (lambda (symbol)
  354.       (or (intern-soft (symbol-name symbol) new)
  355.           (define-abbrev new (symbol-name symbol)
  356.         (symbol-value symbol) (symbol-function symbol)))))
  357.        old)))
  358.     
  359. (provide 'derived)
  360.  
  361. ;;; derived.el ends here
  362.